home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1997 #1 / Amiga Plus CD - 1997 - No. 01.iso / pd / programmierung / quickautodocks / exec.doc < prev    next >
Text File  |  1992-09-03  |  16KB  |  573 lines
  1. exec.library quick autodocs
  2.  
  3. NAME     : AbortIO
  4. FUNCTION : attempt to abort an in-progress I/O request
  5. SYNOPSIS : AbortIO(iORequest)
  6.             -480       A1
  7.  
  8. NAME     : AddDevice
  9. FUNCTION : add a device to the system
  10. SYNOPSIS : AddDevice(device)
  11.              -432      A1
  12.  
  13. NAME     : AddHead
  14. FUNCTION : insert node at the head of a list
  15. SYNOPSIS : AddHead(list,node)
  16.             -240    A0   A1
  17.  
  18. NAME     : AddIntServer
  19. FUNCTION : add an interrupt server to a system server chain
  20. SYNOPSIS : AddIntServer(intNum,interrupt)
  21.                -168       D0       A1
  22.  
  23. NAME     : AddLibrary
  24. FUNCTION : add a library to the system
  25. SYNOPSIS : AddLibrary(library)
  26.               -396       A1
  27.  
  28. NAME     : AddMemHandler
  29. FUNCTION : Add a low memory handler to exec
  30. SYNOPSIS : AddMemHandler(memHandler)
  31.                -774          A1
  32.  
  33. NAME     : AddMemList
  34. FUNCTION : add memory to the system free pool
  35. SYNOPSIS : AddMemList(size,attributes,pri,base,name )
  36.              -618      D0     D1       D2  A0   A1
  37.  
  38. NAME     : AddPort
  39. FUNCTION : add a public message port to the system
  40. SYNOPSIS : AddPort(port)
  41.             -354    A1
  42.  
  43. NAME     : AddResource
  44. FUNCTION : add a resource to the system
  45. SYNOPSIS : AddResource(resource)
  46.               -486        A1
  47.  
  48. NAME     : AddSemaphore
  49. FUNCTION : initialize then add a signal semaphore to the system
  50. SYNOPSIS : AddSemaphore(signalSemaphore)
  51.               -600            A1
  52.  
  53. NAME     : AddTail
  54. FUNCTION : append node to tail of a list
  55. SYNOPSIS : AddTail(list,node)
  56.             -246    A0   A1
  57.  
  58. NAME     : AddTask
  59. FUNCTION : add a task to the system
  60. SYNOPSIS : AddTask(task,initialPC,finalPC)
  61.             -282    A1     A2       A3
  62.  
  63. NAME     : Alert
  64. FUNCTION : alert the user of an error
  65. SYNOPSIS : Alert(alertNum)
  66.             -108    D7
  67.  
  68. NAME     : AllocAbs
  69. FUNCTION : allocate at a given location
  70. SYNOPSIS : memoryBlock=AllocAbs(byteSize,location)
  71.                D0        -204      D0       A1
  72.  
  73. NAME     : Allocate
  74. FUNCTION : allocate a block of memory
  75. SYNOPSIS : memoryBlock=Allocate(memHeader,byteSize)
  76.                D0        -186      A0        D0
  77.  
  78. NAME     : AllocEntry
  79. FUNCTION : allocate many regions of memory
  80. SYNOPSIS : memList=AllocEntry(memList)
  81.              D0       -222      A0
  82.  
  83. NAME     : AllocMem
  84. FUNCTION : allocate memory given certain requirements
  85. SYNOPSIS : memoryBlock=AllocMem(byteSize,attributes)
  86.                D0        -198      D0       D1
  87.  
  88. NAME     : AllocPooled
  89. FUNCTION : Allocate memory with the pool manager
  90. SYNOPSIS : memory=AllocPooled(poolHeader,memSize)
  91.              d0      -708         a0       d0
  92.  
  93. NAME     : AllocSignal
  94. FUNCTION : allocate a signal bit
  95. SYNOPSIS : signalNum=AllocSignal(signalNum)
  96.               D0        -330        D0
  97.  
  98. NAME     : AllocTrap
  99. FUNCTION : allocate a processor trap vector
  100. SYNOPSIS : trapNum=AllocTrap(trapNum)
  101.              D0      -342      D0
  102.  
  103. NAME     : AllocVec
  104. FUNCTION : allocate memory and keep track of the size
  105. SYNOPSIS : memoryBlock=AllocVec(byteSize,attributes)
  106.                D0        -684      D0        D1
  107.  
  108. NAME     : AttemptSemaphore
  109. FUNCTION : try to obtain without blocking
  110. SYNOPSIS : success=AttemptSemaphore(signalSemaphore)
  111.               D0        -576              A0
  112.  
  113. NAME     : AttemptSemaphoreShared
  114. FUNCTION : try to obtain without blocking
  115. SYNOPSIS : success=AttemptSemaphoreShared(signalSemaphore)
  116.              D0           -678                  A0
  117.  
  118. NAME     : AvailMem
  119. FUNCTION : memory available given certain requirements
  120. SYNOPSIS : size=AvailMem(attributes)
  121.             D0    -216      D1
  122.  
  123. NAME     : CacheClearE
  124. FUNCTION : Cache clearing with extended control
  125. SYNOPSIS : CacheClearE(address,length,caches)
  126.               -642       a0      d0     d1
  127.  
  128. NAME     : CacheClearU
  129. FUNCTION : User callable simple cache clearing
  130. SYNOPSIS : CacheClearU()
  131.               -636
  132.  
  133. NAME     : CacheControl
  134. FUNCTION : Instruction & data cache control
  135. SYNOPSIS : oldBits=CacheControl(cacheBits,cacheMask)
  136.              D0        -648         D0        D1
  137.  
  138. NAME     : CachePostDMA
  139. FUNCTION : Take actions after to hardware DMA
  140. SYNOPSIS : CachePostDMA(vaddress,&length,flags)
  141.                -768       a0       a1     d0
  142.  
  143. NAME     : CachePreDMA
  144. FUNCTION : Take actions prior to hardware DMA
  145. SYNOPSIS : paddress=CachePreDMA(vaddress,&length,flags)
  146.              d0         -762      a0       a1     d0
  147.  
  148. NAME     : Cause
  149. FUNCTION : cause a software interrupt
  150. SYNOPSIS : Cause(interrupt)
  151.             -180    A1
  152.  
  153. NAME     : CheckIO
  154. FUNCTION : get the status of an IORequest
  155. SYNOPSIS : result=CheckIO(iORequest)
  156.              D0     -468      A1
  157.  
  158. NAME     : CloseDevice
  159. FUNCTION : conclude access to a device
  160. SYNOPSIS : CloseDevice(iORequest)
  161.                -450       A1
  162.  
  163. NAME     : CloseLibrary
  164. FUNCTION : conclude access to a library
  165. SYNOPSIS : CloseLibrary(library)
  166.                -414        A1
  167.  
  168. NAME     : ColdReboot
  169. FUNCTION : reboot the Amiga
  170. SYNOPSIS : ColdReboot()
  171.               -726
  172.  
  173. NAME     : CopyMem
  174. FUNCTION : general purpose memory copy function
  175. SYNOPSIS : CopyMem(source,dest,size )
  176.              -624    A0    A1   D0
  177.  
  178. NAME     : CopyMemQuick
  179. FUNCTION : optimized memory copy function
  180. SYNOPSIS : CopyMemQuick(source,dest,size )
  181.                -630       A0    A1   D0
  182.  
  183. NAME     : CreateIORequest
  184. FUNCTION : create an IORequest structure
  185. SYNOPSIS : ioReq=CreateIORequest(ioReplyPort,size)
  186.                        -654           A0      D0
  187.  
  188. NAME     : CreateMsgPort
  189. FUNCTION : Allocate and initialize a new message port
  190. SYNOPSIS : CreateMsgPort()
  191.                -666
  192.  
  193. NAME     : CreatePool
  194. FUNCTION : Generate a private memory pool header
  195. SYNOPSIS : newPool=CreatePool(memFlags,puddleSize,threshSize)
  196.              a0      -696        d0        d1         d2
  197.  
  198. NAME     : Deallocate
  199. FUNCTION : deallocate a block of memory
  200. SYNOPSIS : Deallocate(memHeader,memoryBlock,byteSize)
  201.               -192       A0         A1         D0
  202.  
  203. NAME     : Debug
  204. FUNCTION : run the system debugger
  205. SYNOPSIS : Debug(flags)
  206.             -114   D0
  207.  
  208. NAME     : DeleteIORequest
  209. FUNCTION : Free a request made by CreateIORequest
  210. SYNOPSIS : DeleteIORequest(ioReq)
  211.                 -660         A0
  212.  
  213. NAME     : DeleteMsgPort
  214. FUNCTION : Free a message port created by CreateMsgPort
  215. SYNOPSIS : DeleteMsgPort(msgPort)
  216.                 -672       A0
  217.  
  218. NAME     : DeletePool
  219. FUNCTION : Drain an entire memory pool
  220. SYNOPSIS : DeletePool(poolHeader)
  221.               -702        A0
  222.  
  223. NAME     : Disable
  224. FUNCTION : disable interrupt processing
  225. SYNOPSIS : Disable()
  226.             -120
  227.  
  228. NAME     : DoIO
  229. FUNCTION : perform an I/O command and wait for completion
  230. SYNOPSIS : error=DoIO(iORequest)
  231.             D0   -456     A1
  232.  
  233. NAME     : Enable
  234. FUNCTION : permit system interrupts to resume
  235. SYNOPSIS : Enable()
  236.             -126
  237.  
  238. NAME     : Enqueue
  239. FUNCTION : insert or append node to a system queue
  240. SYNOPSIS : Enqueue(list,node)
  241.             -270    A0   A1
  242.  
  243. NAME     : FindName
  244. FUNCTION : find a system list node with a given name
  245. SYNOPSIS : node=FindName(start,name)
  246.             D0       -276    A0    A1
  247.  
  248. NAME     : FindPort
  249. FUNCTION : find a given system message port
  250. SYNOPSIS : port=FindPort(name)
  251.             D0    -390    A1
  252.  
  253. NAME     : FindResident
  254. FUNCTION : find a resident module by name
  255. SYNOPSIS : resident=FindResident(name)
  256.               D0        -96       A1
  257.  
  258. NAME     : FindSemaphore
  259. FUNCTION : find a given system signal semaphore
  260. SYNOPSIS : signalSemaphore=FindSemaphore(name)
  261.                  D0            -594       A1
  262.  
  263. NAME     : FindTask
  264. FUNCTION : find a task with the given name or find oneself
  265. SYNOPSIS : task=FindTask(name)
  266.             D0    -294    A1
  267.  
  268. NAME     : Forbid
  269. FUNCTION : forbid task rescheduling.
  270. SYNOPSIS : Forbid()
  271.             -132
  272.  
  273. NAME     : FreeEntry
  274. FUNCTION : free many regions of memory
  275. SYNOPSIS : FreeEntry(memList)
  276.              -228      A0
  277.  
  278. NAME     : FreeMem
  279. FUNCTION : deallocate with knowledge
  280. SYNOPSIS : FreeMem(memoryBlock,byteSize)
  281.              -210      A1         D0
  282.  
  283. NAME     : FreePooled
  284. FUNCTION : Free pooled memory
  285. SYNOPSIS : FreePooled(poolHeader,memory,memSize)
  286.               -714       a0        a1     d0
  287.  
  288. NAME     : FreeSignal
  289. FUNCTION : free a signal bit
  290. SYNOPSIS : FreeSignal(signalNum)
  291.               -336       D0
  292.  
  293. NAME     : FreeTrap
  294. FUNCTION : free a processor trap
  295. SYNOPSIS : FreeTrap(trapNum)
  296.              -348      D0
  297.  
  298. NAME     : FreeVec
  299. FUNCTION : return AllocVec memory to the system
  300. SYNOPSIS : FreeVec(memoryBlock)
  301.              -690      A1
  302.  
  303. NAME     : GetCC
  304. FUNCTION : get condition codes in a 68010 compatible way
  305. SYNOPSIS : conditions=GetCC()
  306.                D0      -528
  307.  
  308. NAME     : GetMsg
  309. FUNCTION : get next message from a message port
  310. SYNOPSIS : message=GetMsg(port)
  311.               D0    -372   A0
  312.  
  313. NAME     : InitCode
  314. FUNCTION : initialize resident code modules
  315. SYNOPSIS : InitCode(startClass,version)
  316.              -72        D0        D1
  317.  
  318. NAME     : InitResident
  319. FUNCTION : initialize resident module
  320. SYNOPSIS : object=InitResident(resident,segList)
  321.              D0      -102         A1       D1
  322.  
  323. NAME     : InitSemaphore
  324. FUNCTION : initialize a signal semaphore
  325. SYNOPSIS : InitSemaphore(signalSemaphore)
  326.                -558            A0
  327.  
  328. NAME     : InitStruct
  329. FUNCTION : initialize memory from a table
  330. SYNOPSIS : InitStruct(initTable,memory,size)
  331.               -78         A1      A2    D0
  332.  
  333. NAME     : Insert
  334. FUNCTION : insert a node into a list
  335. SYNOPSIS : Insert(list,node,listNode)
  336.             -234   A0   A1     A2
  337.  
  338. NAME     : MakeFunctions
  339. FUNCTION : construct a function jump table
  340. SYNOPSIS : tableSize=MakeFunctions(target,functionArray,funcDispBase)
  341.                D0        -90         A0        A1           A2
  342.  
  343. NAME     : MakeLibrary
  344. FUNCTION : construct a library
  345. SYNOPSIS : library=MakeLibrary(vectors,structure,init,dSize,segList)
  346.               D0       -84       A0        A1     A2    D0    D1
  347.  
  348. NAME     : ObtainQuickVector
  349. FUNCTION : Function to obtain an install a Quick Interrupt vector
  350. SYNOPSIS : vector=ObtainQuickVector(interruptCode)
  351.              D0         -786             A0
  352.  
  353. NAME     : ObtainSemaphore
  354. FUNCTION : gain exclusive access to a semaphore
  355. SYNOPSIS : ObtainSemaphore(signalSemaphore)
  356.                 -564              A0
  357.  
  358. NAME     : ObtainSemaphoreList
  359. FUNCTION : get a list of semaphores
  360. SYNOPSIS : ObtainSemaphoreList(list)
  361.                  -582           A0
  362.  
  363. NAME     : ObtainSemaphoreShared
  364. FUNCTION : gain shared access to a semaphore
  365. SYNOPSIS : ObtainSemaphoreShared(signalSemaphore)
  366.                     -678               A0
  367.  
  368. NAME     : OldOpenLibrary
  369. FUNCTION : obsolete OpenLibrary
  370. SYNOPSIS : library=OldOpenLibrary(libName)
  371.               D0       -408          A1
  372.  
  373. NAME     : OpenDevice
  374. FUNCTION : gain access to a device
  375. SYNOPSIS : error=OpenDevice(devName,unitNumber,iORequest,flags)
  376.              D0     -444       A0       D0         A1      D1
  377.  
  378. NAME     : OpenLibrary
  379. FUNCTION : gain access to a library
  380. SYNOPSIS : library=OpenLibrary(libName, version)
  381.               D0       -552       A1       D0
  382.  
  383. NAME     : OpenResource
  384. FUNCTION : gain access to a resource
  385. SYNOPSIS : resource=OpenResource(resName)
  386.               D0        -498        A1
  387.  
  388. NAME     : Permit
  389. FUNCTION : permit task rescheduling
  390. SYNOPSIS : Permit()
  391.             -138
  392.  
  393. NAME     : Procure
  394. FUNCTION : bid for a semaphore
  395. SYNOPSIS : Procure(semaphore,bidMessage)
  396.              -540     A0         A1
  397.  
  398. NAME     : PutMsg
  399. FUNCTION : put a message to a message port
  400. SYNOPSIS : PutMsg(port,message)
  401.             -366   A0     A1
  402.  
  403. NAME     : RawDoFmt
  404. FUNCTION : format data into a character stream
  405. SYNOPSIS : NextData=RawDoFmt(FormatString,DataStream,PutChProc,PutChData)
  406.               D0      -522        A0          A1        A2        A3
  407.  
  408. NAME     : ReleaseSemaphore
  409. FUNCTION : make signal semaphore available to others
  410. SYNOPSIS : ReleaseSemaphore(signalSemaphore)
  411.                  -570             A0
  412.  
  413. NAME     : ReleaseSemaphoreList
  414. FUNCTION : make a list of semaphores available
  415. SYNOPSIS : ReleaseSemaphoreList(list)
  416.                   -588           A0
  417.  
  418. NAME     : RemDevice
  419. FUNCTION : remove a device from the system
  420. SYNOPSIS : RemDevice(device)
  421.               -438     A1
  422.  
  423. NAME     : RemHead
  424. FUNCTION : remove the head node from a list
  425. SYNOPSIS : node=RemHead(list)
  426.             D0    -258   A0
  427.  
  428. NAME     : RemIntServer
  429. FUNCTION : remove an interrupt server from a server chain
  430. SYNOPSIS : RemIntServer(intNum,interrupt)
  431.                -174       D0       A1
  432.  
  433. NAME     : RemLibrary
  434. FUNCTION : remove a library from the system
  435. SYNOPSIS : RemLibrary(library)
  436.               -402       A1
  437.  
  438. NAME     : RemMemHandler
  439. FUNCTION : Remove low memory handler from exec
  440. SYNOPSIS : RemMemHandler(memHandler)
  441.                 -780         A1
  442.  
  443. NAME     : Remove
  444. FUNCTION : remove a node from a list
  445. SYNOPSIS : Remove(node)
  446.             -252   A1
  447.  
  448. NAME     : RemPort
  449. FUNCTION : remove a message port from the system
  450. SYNOPSIS : RemPort(port)
  451.              -360   A1
  452.  
  453. NAME     : RemResource
  454. FUNCTION : remove a resource from the system
  455. SYNOPSIS : RemResource(resource)
  456.               -492        A1
  457.  
  458. NAME     : RemSemaphore
  459. FUNCTION : remove a signal semaphore from the system
  460. SYNOPSIS : RemSemaphore(signalSemaphore)
  461.                -606           A1
  462.  
  463. NAME     : RemTail
  464. FUNCTION : remove the tail node from a list
  465. SYNOPSIS : node=RemTail(list)
  466.             D0    -264   A0
  467.  
  468. NAME     : RemTask
  469. FUNCTION : remove a task from the system
  470. SYNOPSIS : RemTask(task)
  471.              -288   A1
  472.  
  473. NAME     : ReplyMsg
  474. FUNCTION : put a message to its reply port
  475. SYNOPSIS : ReplyMsg(message)
  476.              -378      A1
  477.  
  478. NAME     : SendIO
  479. FUNCTION : initiate an I/O command
  480. SYNOPSIS : SendIO(iORequest)
  481.             -462      A1
  482.  
  483. NAME     : SetExcept
  484. FUNCTION : define certain signals to cause exceptions
  485. SYNOPSIS : oldSignals=SetExcept(newSignals,signalMask)
  486.                D0        -312      D0          D1
  487.  
  488. NAME     : SetFunction
  489. FUNCTION : change a function vector in a library
  490. SYNOPSIS : oldFunc=SetFunction(library,funcOffset,funcEntry)
  491.              D0       -420        A1       A0        D0
  492.  
  493. NAME     : SetIntVector
  494. FUNCTION : set a new handler for a system interrupt vector
  495. SYNOPSIS : oldInterrupt=SetIntVector(intNumber,interrupt)
  496.                D0           -162        D0         A1
  497.  
  498. NAME     : SetSignal
  499. FUNCTION : define the state of this task's signals
  500. SYNOPSIS : oldSignals=SetSignal(newSignals,signalMask)
  501.               D0         -306      D0          D1
  502.  
  503. NAME     : SetSR
  504. FUNCTION : get and/or set processor status register
  505. SYNOPSIS : oldSR=SetSR(newSR, mask)
  506.              D0   -144   D0    D1
  507.  
  508. NAME     : SetTaskPri
  509. FUNCTION : get and set the priority of a task
  510. SYNOPSIS : oldPriority=SetTaskPri(task, priority)
  511.                D0         -300     A1      D0
  512.  
  513. NAME     : Signal
  514. FUNCTION : signal a task
  515. SYNOPSIS : Signal(task,signals)
  516.             -324   A1    D0
  517.  
  518. NAME     : StackSwap
  519. FUNCTION : EXEC supported method of replacing task's stack
  520. SYNOPSIS : StackSwap(newStack)
  521.               -732      A0
  522.  
  523. NAME     : SumKickData
  524. FUNCTION : compute the checksum for the Kickstart delta list
  525. SYNOPSIS : checksum=SumKickData()
  526.               D0       -612
  527.  
  528. NAME     : SumLibrary
  529. FUNCTION : compute and check the checksum on a library
  530. SYNOPSIS : SumLibrary(library)
  531.               -426       A1
  532.  
  533. NAME     : SuperState
  534. FUNCTION : enter supervisor state with user stack
  535. SYNOPSIS : oldSysStack=SuperState()
  536.                D0         -150
  537.  
  538. NAME     : Supervisor
  539. FUNCTION : trap to a short supervisor mode function
  540. SYNOPSIS : result=Supervisor(userFunc)
  541.              Rx      -30        A5
  542.  
  543. NAME     : TypeOfMem
  544. FUNCTION : determine attributes of a given memory address
  545. SYNOPSIS : attributes=TypeOfMem(address)
  546.                D0        -534     A1
  547.  
  548. NAME     : UserState
  549. FUNCTION : return to user state with user stack
  550. SYNOPSIS : UserState(sysStack)
  551.               -156      D0
  552.  
  553. NAME     : Vacate
  554. FUNCTION : release a bitMessage from Procure
  555. SYNOPSIS : Vacate(semaphore,bidMessage)
  556.             -546      A0        A1
  557.  
  558. NAME     : Wait
  559. FUNCTION : wait for one or more signals
  560. SYNOPSIS : signals=Wait(signalSet)
  561.              D0    -318     D0
  562.  
  563. NAME     : WaitIO
  564. FUNCTION : wait for completion of an I/O request
  565. SYNOPSIS : error=WaitIO(iORequest)
  566.             D0    -474     A1
  567.  
  568. NAME     : WaitPort
  569. FUNCTION : wait for a given port to be non-empty
  570. SYNOPSIS : message=WaitPort(port)
  571.              D0      -384    A0
  572.  
  573.